GitHub Actions Integration

Automatically optimize pull requests with Codeflash GitHub Actions workflow

Codeflash can automatically optimize your code when new pull requests are opened.

To be able to scan new code for performance optimizations, Codeflash requires a GitHub action workflow to be installed which runs the Codeflash optimization logic on every new pull request. If the action workflow finds an optimization, it communicates with the Codeflash GitHub App through our secure servers and asks it to suggest new changes to the pull request.

This is the most useful way of using Codeflash, where you set it up once and all your new code gets optimized. So setting this up is highly recommended.

Prerequisites

Before you begin, make sure you have:

✅ A Codeflash API key from the Codeflash Web App

✅ Completed local installation with codeflash init

✅ A Python project with a configured pyproject.toml file

Setup Options

Automated Setup (Recommended)

1. Run the Setup Command

   codeflash init-actions
   

   This command will automatically create the GitHub Actions workflow file and guide you through the setup process.

2. Test Your Setup

   Open a new pull request to your GitHub project. You’ll see:

   • ✅ A new Codeflash workflow running in GitHub Actions
   • 🤖 The codeflash-ai bot commenting with optimization suggestions (if any are found)

Recommended approach - This automated setup ensures you get the latest workflow configuration with all best practices included.